Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use ansible-ref: devel for docs build workflows #2353

Merged
merged 3 commits into from
Oct 24, 2024
Merged

Use ansible-ref: devel for docs build workflows #2353

merged 3 commits into from
Oct 24, 2024

Conversation

alinabuzachis
Copy link
Collaborator

@alinabuzachis alinabuzachis commented Oct 22, 2024 •
edited
Loading

SUMMARY

Use ansible-ref: devel for docs build workflows.

This needs to be merged in order to reflect the change.

Because of this change ansible/ansible@4f6276d documentation build process was failing with:

  /home/runner/work/_temp/docsbuild/head/rst/collections/amazon/aws/aws_ec2_inventory.rst:309: WARNING: 'envvar' reference target not found: ANSIBLE_INVENTORY_CACHE [ref.envvar]
  /home/runner/work/_temp/docsbuild/head/rst/collections/amazon/aws/aws_ec2_inventory.rst:370: WARNING: 'envvar' reference target not found: ANSIBLE_INVENTORY_CACHE_CONNECTION [ref.envvar]
  /home/runner/work/_temp/docsbuild/head/rst/collections/amazon/aws/aws_ec2_inventory.rst:435: WARNING: 'envvar' reference target not found: ANSIBLE_INVENTORY_CACHE_PLUGIN [ref.envvar]
  /home/runner/work/_temp/docsbuild/head/rst/collections/amazon/aws/aws_ec2_inventory.rst:500: WARNING: 'envvar' reference target not found: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX [ref.envvar]
  /home/runner/work/_temp/docsbuild/head/rst/collections/amazon/aws/aws_ec2_inventory.rst:565: WARNING: 'envvar' reference target not found: ANSIBLE_INVENTORY_CACHE_TIMEOUT [ref.envvar]
  /home/runner/work/_temp/docsbuild/head/rst/collections/amazon/aws/aws_rds_inventory.rst:259: WARNING: 'envvar' reference target not found: ANSIBLE_INVENTORY_CACHE [ref.envvar]
  /home/runner/work/_temp/docsbuild/head/rst/collections/amazon/aws/aws_rds_inventory.rst:320: WARNING: 'envvar' reference target not found: ANSIBLE_INVENTORY_CACHE_CONNECTION [ref.envvar]
  /home/runner/work/_temp/docsbuild/head/rst/collections/amazon/aws/aws_rds_inventory.rst:385: WARNING: 'envvar' reference target not found: ANSIBLE_INVENTORY_CACHE_PLUGIN [ref.envvar]
  /home/runner/work/_temp/docsbuild/head/rst/collections/amazon/aws/aws_rds_inventory.rst:450: WARNING: 'envvar' reference target not found: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX [ref.envvar]
  /home/runner/work/_temp/docsbuild/head/rst/collections/amazon/aws/aws_rds_inventory.rst:515: WARNING: 'envvar' reference target not found: ANSIBLE_INVENTORY_CACHE_TIMEOUT [ref.envvar]
ISSUE TYPE
  • Bugfix Pull Request
  • Docs Pull Request
  • Feature Pull Request
  • New Module Pull Request
COMPONENT NAME
ADDITIONAL INFORMATION

@softwarefactory-project-zuul softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/89497bc9d5b74c098ed46e0ca4481016

✔️ ansible-galaxy-importer SUCCESS in 4m 45s
✔️ build-ansible-collection SUCCESS in 10m 40s

tremble
tremble approved these changes Oct 22, 2024
View reviewed changes
Copy link
Contributor

@tremble tremble left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to do this, but I'm worried it will bit-rot. Kinda wish "latest" was available.

@tremble tremble mentioned this pull request Oct 22, 2024
Merged
@alinabuzachis alinabuzachis changed the title Use ansible-core 2.17 for documentation build Use ansible-ref: devel for docs build workflows Oct 22, 2024
@alinabuzachis alinabuzachis requested a review from tremble October 22, 2024 16:57
felixfontein
felixfontein approved these changes Oct 22, 2024
View reviewed changes
Copy link
Contributor

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem comes from a mismatch of the ansible-core version used for building the docs (that one does not have the commit) and the ansible-core version whose intersphinx links are used (that ansible-core version does have the commit). So antsibull-docs thinks ansible-core still defines these config entries in its docs, so it doesn't add them to the environment variable definition page, but the intersphinx files do not contain the definitions for them anymore.

.github/workflows/docs-pr.yml
@@ -18,6 +18,7 @@ jobs:
with:
init-lenient: false
init-fail-on-error: true
ansible-ref: devel
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bit dangerous since this can break the docs build at any time, but I guess it's OK for now.

@felixfontein
Copy link
Contributor

(The build failure in "Collection Docs" won't go away until this gets merged, since always the workflow file from the main branch is used for it.)

@softwarefactory-project-zuul softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/82bec95e0c064895aae7b4838503e455

✔️ ansible-galaxy-importer SUCCESS in 4m 19s
✔️ build-ansible-collection SUCCESS in 11m 27s

@softwarefactory-project-zuul softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/4de2fb1276924bdc8b82560e6d05259c

✔️ ansible-galaxy-importer SUCCESS in 5m 33s
✔️ build-ansible-collection SUCCESS in 10m 16s

@tremble tremble added the mergeit Merge the PR (SoftwareFactory) label Oct 24, 2024
@softwarefactory-project-zuul softwarefactory-project-zuul
Copy link
Contributor

Build succeeded (gate pipeline).
https://ansible.softwarefactory-project.io/zuul/buildset/2b8f62f3b9a349298e94c274db22ca2a

✔️ ansible-galaxy-importer SUCCESS in 4m 15s
✔️ build-ansible-collection SUCCESS in 10m 09s

@softwarefactory-project-zuul softwarefactory-project-zuul
Copy link
Contributor

Pull request merge failed: Resource not accessible by integration, You may need to manually rebase your PR and retry.

@tremble tremble merged commit d37fbc1 into ansible-collections:main Oct 24, 2024
36 of 37 checks passed
@tremble
Copy link
Contributor

tremble commented Oct 24, 2024

Manual merge needed because it touches the workflows.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@s-hertel s-hertel s-hertel left review comments

@felixfontein felixfontein felixfontein approved these changes

@tremble tremble tremble approved these changes

Assignees
No one assigned
Labels
mergeit Merge the PR (SoftwareFactory)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@alinabuzachis @felixfontein @tremble @s-hertel @GomathiselviS